Copyright © 1996-2013 John W. Eaton.

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.

GNU Octave

This manual documents how to run, install and port GNU Octave, as well as its new features and incompatibilities, and how to report bugs. It corresponds to GNU Octave version 3.8.2.

 — The Detailed Node Listing —

Preface

Introduction

Conventions

Format of Descriptions

Getting Started

Invoking Octave from the Command Line

Command Line Editing

Comments

Data Types

Built-in Data Types

Numeric Data Types

Matrices

Integer Data Types

Strings

Creating Strings

Data Containers

Structures

Cell Arrays

Comma Separated Lists

Variables

Expressions

Index Expressions

Calling Functions

Boolean Expressions

Evaluation

Statements

The switch Statement

The for Statement

Functions and Scripts

Function Files

Function Handles Anonymous Functions Inline Functions

Errors and Warnings

Handling Errors

Handling Warnings

Debugging

Input and Output

Basic Input and Output

Terminal Output

Simple File I/O

C-Style I/O Functions

Plotting

High-Level Plotting

Two-Dimensional Plots

Three-Dimensional Plots

Graphics Data Structures

Graphics Object Properties

Advanced Plotting

Object Groups

Graphics Toolkits

Matrix Manipulation

Arithmetic

Linear Algebra

Vectorization and Faster Code Execution

Nonlinear Equations

Diagonal and Permutation Matrices

Basic Usage

Matrix Algebra

Function Support

Sparse Matrices

Basics

Operators and Functions

Numerical Integration

Differential Equations

Optimization

Statistics

Sets

Polynomial Manipulations

Interpolation

Geometry

Delaunay Triangulation

Image Processing

Object Oriented Programming

Indexing Objects

Overloading Objects

GUI Development

System Utilities

Networking Utilities

Java Interface

FAQ - Frequently asked Questions

Packages

Creating Packages

External Code Interface

Oct-Files

Sparse Matrices in Oct-Files

Mex-Files

Test and Demo Functions

Tips and Standards

Contributing Guidelines

Trouble

Reporting Bugs

Installation

Build Dependencies

Emacs Octave Support

Grammar and Parser

Preface

Octave was originally intended to be companion software for an undergraduate-level textbook on chemical reactor design being written by James B. Rawlings of the University of Wisconsin-Madison and John G. Ekerdt of the University of Texas.

Clearly, Octave is now much more than just another ‘courseware’ package with limited utility beyond the classroom. Although our initial goals were somewhat vague, we knew that we wanted to create something that would enable students to solve realistic problems, and that they could use for many things other than chemical reactor design problems. We find that most students pick up the basics of Octave quickly, and are using it confidently in just a few hours.

Although it was originally intended to be used to teach reactor design, it has been used in several other undergraduate and graduate courses in the Chemical Engineering Department at the University of Texas, and the math department at the University of Texas has been using it for teaching differential equations and linear algebra as well. More recently, Octave has been used as the primary computational tool for teaching Stanford’s online Machine Learning class (ml-class.org) taught by Andrew Ng. Tens of thousands of students participated in the course.

If you find Octave useful, please let us know. We are always interested to find out how Octave is being used.

Virtually everyone thinks that the name Octave has something to do with music, but it is actually the name of one of John W. Eaton’s former professors who wrote a famous textbook on chemical reaction engineering, and who was also well known for his ability to do quick ‘back of the envelope’ calculations. We hope that this software will make it possible for many people to do more ambitious computations just as easily.

Everyone is encouraged to share this software with others under the terms of the GNU General Public License (see section GNU GENERAL PUBLIC LICENSE). You are also encouraged to help make Octave more useful by writing and contributing additional functions for it, and by reporting any problems you may have.

Acknowledgements

Many people have contributed to Octave’s development. The following people have helped code parts of Octave or aided in various other ways (listed alphabetically).

Special thanks to the following people and organizations for supporting the development of Octave:

• The United States Department of Energy, through grant number DE-FG02-04ER25635.
• Ashok Krishnamurthy, David Hudak, Juan Carlos Chaves, and Stanley C. Ahalt of the Ohio Supercomputer Center.
• The National Science Foundation, through grant numbers CTS-0105360, CTS-9708497, CTS-9311420, CTS-8957123, and CNS-0540147.
• The industrial members of the Texas-Wisconsin Modeling and Control Consortium (TWMCC).
• The Paul A. Elfers Endowed Chair in Chemical Engineering at the University of Wisconsin-Madison.
• Digital Equipment Corporation, for an equipment grant as part of their External Research Program.
• Sun Microsystems, Inc., for an Academic Equipment grant.
• International Business Machines, Inc., for providing equipment as part of a grant to the University of Texas College of Engineering.
• Texaco Chemical Company, for providing funding to continue the development of this software.
• The University of Texas College of Engineering, for providing a Challenge for Excellence Research Supplement, and for providing an Academic Development Funds grant.
• The State of Texas, for providing funding through the Texas Advanced Technology Program under Grant No. 003658-078.
• Noel Bell, Senior Engineer, Texaco Chemical Company, Austin Texas.
• John A. Turner, Group Leader, Continuum Dynamics (CCS-2), Los Alamos National Laboratory, for registering the octave.org domain name.
• James B. Rawlings, Professor, University of Wisconsin-Madison, Department of Chemical and Biological Engineering.
• Richard Stallman, for writing GNU.

This project would not have been possible without the GNU software used in and to produce Octave.

Citing Octave in Publications

In view of the many contributions made by numerous developers over many years it is common courtesy to cite Octave in publications when it has been used during the course of research or the preparation of figures. The citation function can automatically generate a recommended citation text for Octave or any of its packages. See the help text below on how to use citation.

Command: citation

Command: citation package

Display instructions for citing GNU Octave or its packages in publications.

When called without an argument, display information on how to cite the core GNU Octave system. When given a package name package, display information on citing the specific named package. Note that some packages may not yet have instructions on how to cite them.

The GNU Octave developers and its active community of package authors have invested a lot of time and effort in creating GNU Octave as it is today. Please give credit where credit is due and cite GNU Octave and its packages when you use them.

How You Can Contribute to Octave

There are a number of ways that you can contribute to help make Octave a better system. Perhaps the most important way to contribute is to write high-quality code for solving new problems, and to make your code freely available for others to use. See section Contributing Guidelines, for detailed information on contributing new code.

If you find Octave useful, consider providing additional funding to continue its development. Even a modest amount of additional funding could make a significant difference in the amount of time that is available for development and support.

Donations supporting Octave development may be made on the web at https://my.fsf.org/donate/working-together/octave. These donations also help to support the Free Software Foundation

If you’d prefer to pay by check or money order, you can do so by sending a check to the FSF at the following address:

Free Software Foundation
51 Franklin Street, Suite 500
Boston, MA 02110-1335
USA

If you pay by check, please be sure to write “GNU Octave” in the memo field of your check.

If you cannot provide funding or contribute code, you can still help make Octave better and more reliable by reporting any bugs you find and by offering suggestions for ways to improve Octave. See section Known Causes of Trouble, for tips on how to write useful bug reports.

Distribution

Octave is free software. This means that everyone is free to use it and free to redistribute it on certain conditions. Octave is not, however, in the public domain. It is copyrighted and there are restrictions on its distribution, but the restrictions are designed to ensure that others will have the same freedom to use and redistribute Octave that you have. The precise conditions can be found in the GNU General Public License that comes with Octave and that also appears in GNU GENERAL PUBLIC LICENSE.

To download a copy of Octave, please visit http://www.octave.org/download.html.

1. A Brief Introduction to Octave

GNU Octaveは主に数値計算を意図した、ハイレベル言語であり、通常は線形、および非線形の代数、数値線形代数(numerical linear algebra)、統計分析を解決したり、その他の数値実験(numerical experiment)を行なうために使用されます。また、自動化されたデータ処理のための、バッチ指向言語としても使用されます。

最近まで、GNU Octaveは別ウィンドウでグラフィカルな結果を表示する、コマンドラインインターフェイスを提供していました。最新のバージョン(2013年後半にリリースされたバージョン3.8)は、デフォルトではグラフィカルユーザーインターフェイスも提供します。

GNU Octaveは自由に再頒布できるソフトウェアです。Free Software Foundationから公表されたGNU General Public Licenseの条件に基づき、あなたはこれを再頒布、かつ/または改変することができます。GPLは、このマニュアルのsee section GNU GENERAL PUBLIC LICENSEに含まれています。

このマニュアルはGNU Octaveのインストール、実行、使用に関する包括的なドキュメントを提供します。バグ報告やコードの寄贈については、追加のチャプターで説明します。

このドキュメントは、Octave バージョン3.8.2に対応します。

1.1 Running Octave

大部分のシステムでは、シェルコマンド‘octave’によりOctaveが起動されます。デフォルトでは、このコマンドによりグラフィカルユーザーインターフェイス(GUI)が起動します。このGUIの中の中央のウィンドウは、Octaveのコマンドラインインターフェイスです。Octaveは初期メッセージを表示してから、入力を受け取る準備ができたことを示すプロンプトを表示します。伝統的なコマンドラインインターフェイスを選択していた場合には、コマンドプロンプトだけが表示されます。どちらの場合でも、すぐにOctaveコマンドのタイプを開始できます。

問題が起きた場合、通常はControl-C(略記はC-c)をタイプすることにより、Octaveに割り込むことができます。C-cの名前は、<CTRL>を押したまま<c>を押すという事実が由来です。これを行なうことにより、通常はOctaveのプロンプトに戻ることができるでしょう。

Octaveを終了するには、Octaveのプロンプトでquit、または, exitとタイプします。

ジョブ制御をサポートするシステムでは、通常はC-zとタイプしてSIGTSTPシグナルを送ることにより、Octaveをサスペンドすることができます。

1.2 Simple Examples

以降のチャプターでは、Octaveのもつすべての機能の詳細を説明しますが、その前にOctaveの能力を示すサンプルを見ておくことが助けになるかもしれません。

Octaveに触れるのが初めてならば、これらのサンプルを試して実際にOctaveを使ってみることから、Octaveの学習を開始することをおすすめします。‘octave:13>’のようにマークされたラインは、あなたがタイプして最後にエンターで終了するラインです。するとOctaveは答えを示すか、グラフを表示するでしょう。

1.2.1 Elementary Calculations

Octaveでは、基本的な数値計算を簡単に行うことができ、算術演算子(+,-,*,/)、べき乗(^)、対数と指数(log, exp)、三角関数(sin, cos, …)を認識します。さらにOctaveでの演算は実数に加えて虚数(i,j)にも機能します。また、自然対数の底(e)や円周率(pi)などの数学定数が事前に定義されています。

たとえばオイラーの等式

 i*pi
e     = -1

を検証するためには、以下をタイプすると、これは計算の許容誤差(tolerance of the calculation)とともに-1に評価されるでしょう。

octave:1> exp (i*pi)

1.2.2 Creating a Matrix

ベクターとマトリクスは、数値解析における基本的な構成要素です。新たにマトリクスを作成して、それを変数に格納すれば、コマンドをタイプして後からそれを参照できます

octave:1> A = [ 1, 1, 2; 3, 5, 8; 13, 21, 34 ]

Octaveは、列で整列されたマトリクスを表示して応答するでしょう。 Octave will respond by printing the matrix in neatly aligned columns.

Octaveは行の中の区切りにカンマ、またはスペースを使い、行ごとの区切りにはセミコロン、または改行を使用します。コマンドの最後にセミコロンを入力した場合、Octaveはコマンドの結果をプリントしません。たとえば、

octave:2> B = rand (3, 2);

これは、それぞれの要素が0から1の間の乱数であるような、3行2列のマトリクスを作成します。

変数の値を表示するには、プロンプトで、単に変数名をタイプします。たとえばBに格納されたマトリクスの値を表示するには、以下のコマンドをタイプします

octave:3> B

1.2.3 Matrix Arithmetic

Octaveには、行列演算を行なうための、便利な演算子があります。たとえばマトリクスAにスカラー値を乗ずるには、以下のコマンドを試してみてください

octave:4> 2 * A

2つの行列AとBの内積は、以下のコマンドをタイプします

octave:5> A * B

行列の積 transpose (A) * A, を得るには、以下のコマンドをタイプします

octave:6> A' * A

1.2.4 Solving Systems of Linear Equations

数値解析において、線形方程式系(systems of linear equations)は至るところに現れます。一連の線形方程式Ax = bを解くには、左除算演算子(left division operator) ‘\’を使います:

x = A \ b

これは、概念的には以下と等価です inv (a) * b, しかし、左除算演算子を使うことにより、逆行列を直接計算するのを避けることができます。

係数行列(coefficient matrix)が正則(singular)な場合、Octaveは警告をプリントして、最小ノルム解(minimum norm solution)を計算します。

化学から簡単な例を1つ。バランスのとれた化学反応式(balanced chemical equations)を得たいとします。水素と酸素の燃焼による水の生成を考えてみましょう。

H2 + O2 --> H2O

この化学反応式は正確ではありません。質量保存の法則により、各分子の数は反応式の左辺と右辺でバランスが取れている必要があります。反応を通じて水素と酸素について個別に方程式を記述すると、以下のようになります:

x1*H2 + x2*O2 --> H2O
H: 2*x1 + 0*x2 --> 2
O: 0*x1 + 2*x2 --> 1

Octaveでは、3つのステップだけでこれを解くことができます。

octave:1> A = [ 2, 0; 0, 2 ];
octave:2> b = [ 2; 1 ];
octave:3> x = A \ b

1.2.5 Integrating Differential Equations

Octaveには、以下の形式をもち

dx
-- = f (x, t)
dt

初期条件が以下であるような非線形方程式を解くビルトイン関数があります

x(t = t0) = x0

このような形式の関数をOctaveで積分するには、最初にその関数の定義を与えなければなりません f(x,t). これは簡単です。コマンドライン上で関数のボディを直接入力していけばよいのです。たとえば、以下のコマンドは、ある非線形微分方程式の着目する変数ペアにたいする右辺の関数を定義しています。関数を入力する間、Octaveは異なるプロンプトで応答することに注意してください。これは入力が完了するまでOctaveが待機していることを示します。

octave:1> function xdot = f (x, t) 
>
>  r = 0.25;
>  k = 1.4;
>  a = 1.5;
>  b = 0.16;
>  c = 0.9;
>  d = 0.8;
>
>  xdot(1) = r*x(1)*(1 - x(1)/k) - a*x(1)*x(2)/(1 + b*x(1));
>  xdot(2) = c*a*x(1)*x(2)/(1 + b*x(1)) - d*x(2);
>
> endfunction

次に初期条件を与えます

octave:2> x0 = [1; 2];

そして出力時間を列ベクトルとしてセットします(1番目の出力時間は上記で与えた初期条件に対応することに注意してください)

octave:3> t = linspace (0, 50, 200)';

微分方程式の組を積分するのは簡単です:

octave:4> x = lsode ("f", x0, t);

関数lsodeは、「A. C. Hindmarsh, ODEPACK, a Systematized Collection of ODE Solvers, in: Scientific Computing, R. S. Stepleman et al. (Eds.), North-Holland, Amsterdam, 1983」の55ページから64ページで説明されている、"Livermore Solver for Ordinary Differential Equation"を使用しています。

1.2.6 Producing Graphical Output

前の例の解をグラフィカルに表示するには、以下のコマンドを使用します

octave:1> plot (t, x)

グラフィカルユーザーインターフェイスを使用している場合、Octaveはプロットを表示するための別ウィンドウを自動的に作成するでしょう。

1度スクリーンに表示されたプロットを保存するには、printコマンドを使用します。たとえば、

print -deps foo.eps

Encapsulated PostScriptフォーマットで描画された現在のプロットを含む、‘foo.eps’というファイルを作成します。また、以下のコマンド

help print

は、printにたいする他のオプションの説明と、出力ファイルフォーマットの追加リストを提供します。

1.2.7 Editing What You Have Typed

Octaveプロンプトでは、Emacsスタイル、またはviスタイルを使用した、以前のコマンドの再呼び出し、編集、再実行が可能です。デフォルトのキーバインディングは、Emacsスタイルのコマンドを使用します。たとえば、前のコマンドを再び呼び出すには、Control-p(略記するとC-p)を押します。これを行なうことにより、入力した以前の行に戻ることができます。他にも、C-nで入力の次の行、C-bでカーソルをその行の後方へ移動、C-fでカーソルをその行の前方へ移動などができます。

コマンドライン編集の能力に関する完全な説明は、このマニュアルのsee section Command Line Editingで提供されています。

1.2.8 Help and Documentation

Octaveには豊富なヘルプ機能があります。Octaveプロンプトから、同じドキュメントのプリント形式が利用できます。これはドキュメントの各形式が、同じ入力ファイルから作成されているからです。

望ましいヘルプを得るには、まず使いたいコマンドの名前を知る必要があります。この関数の名前が明確でない場合もあります。そのようなときは、help --listとタイプするのがよい出発点です。これはすべての演算子、キーワード、ビルトイン関数、Octaveのカレントセッションで利用できるロード可能な関数をすべて表示します。代替としては、lookfor関数を使ってドキュメントを検索する方法もあります。この関数は、Commands for Getting Helpで説明されています。

使いたい関数の名前が解ったら、単にhelpの引数にその関数の名前を含めることで、さらなるヘルプを入手できます。たとえば、

help plot

これはplot関数のヘルプテキストを表示します。

Octaveは、1つのスクリーンに収まらないような長い出力を、lessやmore風のページャーを通じて送ります。<RET>をタイプすると1行、<SPC>で1ページ進み、<q>でページャーを抜けます。

Octave内ででプリントされたマニュアルの完全なテキストを読むことができるOctaveのヘルプ機能の一部は、通常はInfoと呼ばれる別のプログラムを使用します。Infoを呼び出すと、Octaveマニュアル全体を含んだメニュー駆動型のプログラムが起動されます。Infoの使用に関するヘルプは、このマニュアルのsee section Commands for Getting Helpで提供されています。

1.3 Conventions

このセクションでは、このマニュアルで使われている表記規約について説明します。あなたはこのセクションを飛ばして、あとで参照したいと思うかもしれません。

1.3.1 Fonts

Octaveコードの例は、svd (a)のようなフォントまたは形式で表します。変数や関数の引数の名前を示す場合は、first-numberのようなフォントまたは形式で表します。シェルプロンプト上でタイプするコマンドは、‘octave --no-init-file’のようなフォントまたは形式で表します。Octaveプロンプト上でタイプするコマンドは、foo --bar --bazのようなフォントまたは形式で表す場合があります。キーボード上の特定のキーは、<ANY>のようなフォントまたは形式で表します。

1.3.2 Evaluation Notation

このマニュアル内の例では、あなたが評価した式の結果は、‘⇒’で示されます。たとえば、

sqrt (2)
     ⇒ 1.4142

あなたはこれを、“sqrt (2)は1.4142に評価された”と読み替えることができます。

式によりリターンされるマトリクス値は、以下のように表示される場合があります

[1, 2; 3, 4] == [1, 3; 2, 4]
     ⇒ [ 1, 0; 0, 1 ]

また、以下のように表示される場合もあります

eye (3)
     ⇒  1  0  0
         0  1  0
         0  0  1

これは結果の構造を明確にするためです。

1つの式を説明するのに、同じ結果を生成する別の式を示すのが助けになる場合もあります。式の完全な等価は、‘≡’で表します。たとえば:

rot90 ([1, 2; 3, 4], -1)
≡
rot90 ([1, 2; 3, 4], 3)
≡
rot90 ([1, 2; 3, 4], 7)

1.3.3 Printing Notation

このマニュアルの例の多くは、評価されたときにテキストをプリントします。このマニュアルでは、例の結果としてプリントされるものを、‘-|’で表します。式の評価によりリターンされた値(次の例の1)は、続けて別の行に‘⇒’で表します。

printf ("foo %s\n", "bar")
     -| foo bar
     ⇒ 1

1.3.4 Error Messages

エラーをシグナルする例もいくつかあります。これらは通常、端末上にエラーメッセージを表示します。エラーメッセージは行頭のerror:で表します。

fieldnames ([1, 2; 3, 4])
error: fieldnames: Invalid input argument

1.3.5 Format of Descriptions

このマニュアルでは、関数とコマンドは統一されたフォーマットで説明されています。説明の最初の行には、そのアイテムの名前と、もしあれば引数が含まれます。 行の先頭はカテゴリー—function、commandなど—が表示されます。 後続の行が説明で、例を含む場合もあります。

1.3.5.1 A Sample Function Description

関数の説明では、説明される関数の名前が最初に表示されます。同じ行にパラメーターのリストが続きます。パラメーターに使用された名前は、説明の本文でも使用されます。

以下は、架空の関数fooの説明です:

Function File: foo (x)

Function File: foo (x, y)

Function File: foo (x, y, …)

関数fooはyからxを減じたのち、残りの引数を結果に加算します。yが与えられない場合、デフォルトとして数値19が使用されます。

foo (1, [3, 5], 3, 9) ⇒ [ 14, 16 ] foo (5) ⇒ 14

より一般的には、

foo (w, x, y, …) ≡ x - w + y + …

名前に型名(例: integerやmatrix)を含むパラメーターは、その型が期待されます。objectという名前のパラメーターは、任意の型です。他の種類の名前(例: new_file)をもつパラメーターについては、その関数の説明の中で個別に説明されます。いくつかのセクションでは、複数の関数で共通のパラメーターは、最初に説明されます。

Octave内の関数は、複数の異なる方法で定義されているかもしれません。関数のカテゴリー名には、その関数が定義された方法を示す他の名前が含まれる場合があります。これらの追加タグには以下が含まれます。

Function File

説明されている関数は、テキストファイルに格納されたOctaveコマンドにより定義されています。Function Filesを参照してください。

Built-in Function

説明されている関数は、C++、C、またはFortranのような言語で記述されており、コンパイル済みOctaveバイナリーの一部です。

Loadable Function

説明されている関数は、C++、C、またはFortranのような言語で記述されています。ユーザー定義関数の動的リンクをサポートするシステムでは、Octaveの実行中に、必要なときだけ自動的にリンクされます。

Mapping Function

説明されている関数は、マトリクスおよびベクター引数の要素ごとに作用します。

1.3.5.2 A Sample Command Description

コマンドの説明は、単語‘Function’が‘Command’置き換わることを除き、関数の説明と同じフォーマットです。コマンドとは、引数をカッコで括らずに呼び出される関数です。たとえば、以下はOctaveのcdコマンドの説明です。

Command: cd dir

Command: chdir dir

カレント作業ディレクトリーをdirに変更します。たとえばcd ~/octaveは、カレント作業ディレクトリーを‘~/octave’に変更します。そのディレクトリーが存在しない場合、エラーメッセージをプリントし、作業ディレクトリーは変更されません。

2. Getting Started

このチャプターでは、Octaveの基本的な機能についていくつか説明します。それらの機能にはOctaveセッションの開始、コマンドプロンプトでのヘルプの入手、コマンド行の編集、シェルプロンプトからコマンドとして実行可能なOctaveプログラムの記述が含まれます。

2.1 Invoking Octave from the Command Line

Octaveは通常、引数を指定せずに‘octave’プログラムを実行することにより、対話的に使用されます。一度開始すると、exitを指示するまで、Octaveは端末からコマンドを読み取ります。

コマンドラインにファイル名を指定することもできます。この場合、Octaveはその名前のファイルからコマンドを読み込んで実行し、それが終了したらexitします。

さらに次のセクションで説明するコマンドラインオプションにより、Octaveをどのように開始するか、制御することができます。Octave自身が、利用できるオプションを知らせることができます。‘octave --help’(短い形式は‘octave -h’)とタイプすると、利用できるすべてのオプションと、使い方の簡略が表示されます。

2.1.1 Command Line Options

以下は、Octaveに指定できるコマンドラインオプションの、完全なリストです。

--built-in-docstrings-file filename

Octaveのビルトイン関数のドキュメント文字列を含むファイルの名前を指定します。この値は通常は正しいので、異常な状況において指定する必要なときだけ指定するべきです。

--debug

-d

パーサーのデバッグモードに入ります。このオプションを使うことにより、Octaveが読み込んだコマンドについて、Octaveパーサーが大量の情報をプリントするようになるので、おそらくパーサーのデバッグを実際に試みるときだけ有用でしょう。

--debug-jit

JITコンパイラーのデバッグとトレースを有効にします。

--doc-cache-file filename

使用するドキュメントキャッシュファイルを指定します。コマンドラインで指定されたfilenameの値は、環境変数OCTAVE_DOC_CACHE_FILEの値をオーバーライドします。しかし、doc_cache_fileを使用する、システムまたはユーザーのスタートアップファイルのコマンドを除きます。

--echo-commands

-x

コマンドが実行されると、そのコマンドをエコーします。

--eval code

codeを評価して、‘--persist’が共に指定されていなければ、評価の終了と共にexitします。

--exec-path path

実行するプログラムうぃ検索するパスを指定します。コマンドラインで指定されたpathの値は、環境変数OCTAVE_EXEC_PATHの値をオーバーライドします。しかし、ビルトイン変数EXEC_PATHをセットする、システムまたはユーザーのスタートアップファイルのコマンドを除きます。

--force-gui

起動時にグラフィカルユーザーインターフェイス(FUI)を強制します。

--help

-h

-?

短いヘルプメッセージをプリントして、exitします。

--image-path path

イメージを検索するパスのheadにパスを追加します。コマンドラインで指定されたpathの値は、環境変数OCTAVE_IMAGE_PATHの値をオーバーライドします。しかし、ビルトイン変数IMAGE_PATHをセットする、システムまたはユーザーのスタートアップファイルのコマンドを除きます。

--info-file filename

使用するinfoファイルの名前を指定します。コマンドラインでfilenameに指定された値は、環境変数OCTAVE_INFO_FILEの値をオーバーライドします。しかし、info_file関数を使用する、システムまたはユーザーのスタートアップファイルのコマンドを除きます。

--info-program program

使用するinfoプログラムの名前を指定します。コマンドラインで指定されたprogramの値は、環境変数OCTAVE_INFO_PROGRAMの値をオーバーライドします。しかし、info_program関数を使用する、システムまたはユーザーのスタートアップファイルのコマンドを除きます。

--interactive

-i

対話的な動作を強制します。これはリモートシェルコマンドやEmacsのシェルバッファーを通じてOctaveを実行するとき便利かもしれません。

--jit-compiler

JITコンパイラーのループ高速化を有効にします。

--line-editing

コマンドライン編集に、readlineの使用を強制します。

--no-gui

グラフィカルユーザーインターフェイス(GUI)を無効にして、かわりにコマンドラインインターフェイス(CLI)を使用します。

--no-history

-H

コマンドラインのヒストリーの記録を無効にします。

--no-init-file

初期化ファイル‘~/.octaverc’および‘.octaverc’を読み込みません。

--no-init-path

デフォルトの場所を含めるための、関数ファイル用の検索パス初期化を行いません。

--no-line-editing

コマンドライン編集を無効にします。

--no-site-file

サイト単位の初期化ファイル‘octaverc’を読み込みません。

--no-window-system

-W

グラフィックスを含めてウィンドウシステムの使用を無効にします。これは端末だけに制限された環境を強制します。

--norc

-f

スタートアップ時に、システムまたはユーザーの初期化ファイルを読み込みません。これは、‘--no-init-file’と‘--no-site-file’の両方のオプションを使用することと同じです。

--path path

-p path

関数ファイルの検索パスにheadにパスを追加します。コマンドラインで指定されたpathの値は、環境変数OCTAVE_PATHの値をオーバーライドします。しかしシステムまたはユーザーのスタートアップファイルで、path関数のいずれかを通じてセットされた内部のloadパスは除きます。

--persist

‘--eval’またはコマンドラインで指定された名前のファイルを読み込んだ後に、インタラクティブモードに移ります。

--silent

--quiet

-q

起動時に通常のグリーティングメッセージとバージョンメッセージをプリントしません。

--texi-macros-file filename

makeinfoにより使用されるTexinfoマクロを含むファイルの名前を指定します。

--traditional

--braindead

MATLABとの互換のために、ユーザープリファレンスとして、以下の値を初期値としてセットします。

PS1 = ">> " PS2 = "" allow_noninteger_range_as_index = true beep_on_error = true confirm_recursive_rmdir = false crash_dumps_octave_core = false save_default_options = "-mat-binary" do_braindead_shortcircuit_evaluation = true fixed_point_format = true history_timestamp_format_string = "%%-- %D %I:%M %p --%%" page_screen_output = false print_empty_dimensions = false

そして、以下の警告を無効にします。

Octave:abbreviated-property-match Octave:fopen-file-in-path Octave:function-name-clash Octave:load-file-in-path

これはOctave:matlab-incompatible警告を有効にしないことに注意してください。Octaveでは機能するが、MATLABでは機能しないコードの記述にたいして警告してほしいときは、この警告を有効にしたいと思うでしょう(詳細はwarning、およびwarning_idsを参照してください)。

--verbose

-V

詳細な出力に切り替えます。

--version

-v

プログラムのバージョンナンバーをプリントしてexitします。

file

fileのコマンドを実行します。‘--persist’が指定されていない場合は、実行が終了した後にexitします。

Octaveには、引数の数やすべてのオプションなど、コマンドラインの情報についてリターンする関数がいくつかあります。

Built-in Function: argv ()

Octaveに渡されたコマンドライン引数をリターンします。たとえば以下のようなコマンドを使用してOctaveを呼び出した場合、

octave --no-line-editing --silent

argvは、要素が‘--no-line-editing’と‘--silent’であるようなセル配列をリターンするでしょう。

実行可能なOctaveスクリプトを記述した場合、argvはそのスクリプトに渡された引数のリストをリターンします。実行可能なOctaveスクリプトを記述する例は、Executable Octave Programsを参照してください。

Built-in Function: program_name ()

program_invocation_nameからリターンされた値(フルパス)の、最後の成分(ファイル名)をリターンします。

See also: program_invocation_name.

Built-in Function: program_invocation_name ()

Octaveを実行するためにシェルプロンプトにタイプされた名前をリターンします。

コマンドラインからスクリプトを実行した場合(例: octave foo.m)、あるいは実行可能なOctaveスクリプトを使用した場合、プログラム名はしのスクリプトの名前にセットされます。実行可能なOctaveスクリプトを作成する例は、Executable Octave Programsを参照してください。

See also: program_name.

以下は、これらの関数を使用して、Octaveを呼び出したコマンドラインを再現する例です

printf ("%s", program_name ());
arg_list = argv ();
for i = 1:nargin
  printf (" %s", arg_list{i});
endfor
printf ("\n");

セル配列からオブジェクトを取得する方法についての説明はIndexing Cell Arrays、変数narginについての情報はDefining Functionsを参照してください。

2.1.2 Startup Files

Octaveが開始されるとき、Octaveは以下のリストのファイルから、実行するコマンドを探します。これらのファイルには、関数定義を含む、任意の有効なOctaveコマンドが含まれるでしょう。

octave-home/share/octave/site/m/startup/octaverc

octave-homeはOctaveがインストールされたディレクトリーです(デフォルトは‘/usr/local’))。このファイルは、デフォルトのOctave環境にたいする変更を、そのサイトのすべてのユーザー、インストールされたOctaveのすべてのバージョンにたいして全体的に適用するために提供されています。このファイルへの変更は、そのサイトのOctaveユーザーすべてに影響を与えるため、注意を払うべきです。デフォルトファイルは、環境変数yによりオーバーライドされるかもしれません。

octave-home/share/octave/version/m/startup/octaverc

octave-homeはOctaveがインストールされたディレクトリー(デフォルトは‘/usr/local’)、versionはOctaveのバージョンナンバーです。このファイルは、特定のバージョンのOctaveを使用するすべてのユーザーにたいして、デフォルトのOctave環境への変更を全体的に適用するために提供されています。そのサイトで対象となるバージョンのOctaveを使用するすべてのユーザーに影響を与えるため、このファイルの変更には注意が払われるべきです。デフォルトファイルは環境変数OCTAVE_VERSION_INITFILEにより、オーバーライドされるかもしれません。

~/.octaverc

このファイルは、デフォルトOctave環境にたいして個人的に変更を行なうために使用されます。

.octaverc

このファイルは、特定のプロジェクトのデフォルトOctave環境にたいして変更を行なうために使用されます。Octaveは、‘~/.octaverc’を読み込んだ後に、カレントディレクトリーからこのファイルを検索します。‘~/.octaverc’ファイル内でのcdコマンドの使用は、Octaveが‘.octaverc’を検索するディレクトリーに影響を与えます。

ホームディレクトリーでOctaveを開始した場合、ファイル‘~/.octaverc’のコマンドは一度だけ実行されます。

‘--silent’オプションを指定せずに‘--verbose’オプションでOctaveを呼び出した場合、スタートアップファイルが読み込まれるたびに、メッセージが表示されます。

どのようなカスタマイズが可能で、どのカスタマイズが有効になっているかを決定するには、dump_prefs関数が便利です。

Function File: dump_prefs ()

Function File: dump_prefs (fid)

後からOctaveでパースできる形式で、現在のすべてのユーザープリファレンス変数をダンプします。fidはfopenからリターンされたファイルディスクリプターです。fileが省略された場合、リストはstdoutにプリントされます。

2.2 Quitting Octave

Built-in Function: exit (status)

Built-in Function: quit (status)

現在のOctaveセッションをexitします。オプションの整数値statusが与えられた場合、Octaveのexit statusとして、その値をオペレーティングシステムに渡します。デフォルト値は0です。

Built-in Function: atexit (fcn)

Built-in Function: atexit (fcn, flag)

Octaveをexitするときに呼び出される関数を登録します。たとえば、

function last_words () disp ("Bye bye"); endfunction atexit ("last_words");

これはOctaveをexitするとき、メッセージ"Bye bye"をプリントします。

追加の引数flagは、Octaveをexitするときに呼び出される関数のリストに、fcnを登録、または登録を取り消します。flagがtrueの場合、その関数は登録され、flagの場合は、その関数の登録が取り消されます。たとえば、上述の関数last_wordsを登録した後に

atexit ("last_words", false);

これはリストから関数を取り除くので、Octaveがexitするときlast_wordsは呼び出されません。

atexitはリストから最初の関数だけを取り除くことに注意してください。atexitによりリストに関数が複数ある場合は、同じように複数回取り除かなければなりません。

2.3 Commands for Getting Help

このマニュアルのテキスト全体は、Octaveプロンプトからdocコマンドを通じて利用できます。さらにユーザーが独自に記述した関数や変数のドキュメントも、helpコマンドを通じて利用できます。このセクションでは、マニュアルやユーザーが定義した関数や変数のドキュメント文字列を読むために使用するコマンドを説明します。作成した関数のドキュメント記述については、Function Filesを参照してください。

Command: help name

Command: help --list

Command: help .

nameにたいするヘルプテキストを表示します。たとえば、コマンドhelp helpはhelpコマンドを説明する短いメッセージをプリントします。

単一の引数--listが与えられた場合は、演算子、キーワード、ビルトイン関数、および現在のOctaveセッションで利用できるロード可能な関数を、すべてリストします。

単一も引数.が与えられた場合は、現在のOctaveセッションで利用できる、すべての演算子をリストします。

引数を指定せずに呼び出した場合、helpはコマンドラインからヘルプにアクセスする手順を表示します。

helpコマンドにより、コマンドの区切り文字に使用されるカンマとセミコロンを除いた、演算子の情報を得ることができます。それらについてのヘルプを得るには、help commaやhelp semicolonとタイプしなければなりません。

See also: doc, lookfor, which.

Command: doc function_name

GNU Infoブラウザを使用して、プリントされたマニュアルのオンラインバージョンから、関数function_nameのドキュメントを直接表示します。引数を指定せずに呼び出した場合、マニュアルの冒頭から表示されます。

たとえば、コマンドdoc randはマニュアルのオンラインバージョンのrandノードからGNU Infoブラウザを開始します。

GNU Infoブラウザが実行されると、コマンドC-hを使用して、使い方のヘルプを得ることができます。

See also: help.

Command: lookfor str

Command: lookfor -all str

Function File: [func, helpstring] = lookfor (str)

Function File: [func, helpstring] = lookfor ("-all", str)

現在の関数検索パスで見つかったすべての関数の中から、文字列strを検索します。デフォルトでは、lookforは見つかった関数それぞれのヘルプ文字列の最初のセンテンスからstrを検索します。引数"-all"が与えられた場合は、それぞれの関数のヘルプテキスト全体から検索します。検索はすべて大文字小文字を区別しません。

出力引数を指定せずに呼び出された場合、lookforはマッチした関数のリストを端末にプリントします。指定された場合、出力引数funcおよびhelpstringには、マッチした関数とその関数のヘルプ文字列の最初のセンテンスが定義されます。

最初のセンテンスを正しく認識するlookforの能力は、その関数のヘルプのフォーマットに依存します。Octaveの中心的な関数はすべて正しくフォーマットされていますが、外部パッケージとユーザー定義関数について同様に保証することはできません。したがって、Octaveの一部ではない、関連のある関数を見つけるために、"-all"引数の使用が必要になるかもしれません。

See also: help, doc, which.

Octaveのカレントリリースで何が新しくなったか確認するには、news関数を使用します。

Command: news

Command: news package

OctaveまたはインストールされたパッケージのカレントNEWSファイルを表示します。

引数を指定せずに呼び出した場合は、OctaveのNEWSファイルを表示します。パッケージ名packageが与えられた場合は、そのパッケージのカレントNEWSファイルを表示します。

Function File: info ()

GNU Octaveコミュニティーに連絡を取るための情報を表示します。

Built-in Function: warranty ()

Octaveを複製、および配布するための条件を説明します。

以下の関数は、ドキュメントを表示するために使用されるプログラムｙｓ，ドキュメントを探す場所を変更するために使用されます。

Built-in Function: val = info_file ()

Built-in Function: old_val = info_file (new_val)

Built-in Function: info_file (new_val, "local")

Octaveのinfoファイルの名前を指定する内部変数にたいして問い合わせ、またはセットをします。デフォルト値は‘octave-home/info/octave.info’です。octave-homeはOctaveをインストールしたルートディレクトリーです。デフォルト値は、環境変数OCTAVE_INFO_FILE、またはコマンドライン引数‘--info-file FNAME’によりオーバーライドされるかもしれません。

関数内から"local"と共に呼び出された場合、変数にたいする変更は、その関数と関数が呼び出すサブルーチンにたいしてローカルになります。その関数をexitするとき、変数の元の値がリストアされます。

See also: info_program, doc, help, makeinfo_program.

Built-in Function: val = info_program ()

Built-in Function: old_val = info_program (new_val)

Built-in Function: info_program (new_val, "local")

実行するinfoプログラムの名前を指定する内部変数の問い合わせ、またはセットを行います。デフォルト値は‘octave-home/libexec/octave/version/exec/arch/info’で、octave-homeはOctaveをインストールしたルートディレクトリー、versionはOctaveのバージョンナンバー、そしてarchはシステムタイプ(たとえばi686-pc-linux-gnu)です。デフォルト値は、環境変数OCTAVE_INFO_PROGRAM、またはコマンドライン引数‘--info-program NAME’でオーバーライドされるかもしれません。

関数の中から"local"オプションと共に呼び出された場合、変数への変更ははその関数および関数のサブルーチンにたいしてローカルになります。その関数をexitするときに、変数の元の値がリストアされます。

See also: info_file, doc, help, makeinfo_program.

Built-in Function: val = makeinfo_program ()

Built-in Function: old_val = makeinfo_program (new_val)

Built-in Function: makeinfo_program (new_val, "local")

Texinfoのマークアップコマンドを含むヘルプテキストをフォーマットするためにOctaveが実行するプログラム名を指定する内部変数にたいして、問い合わせまたはセットを行います。デフォルト値はmakeinfoです。

関数の中から"local"オプションと共に呼び出された場合、その変数にたいする変更は、その関数および関数のサブルーチンにたいしてローカルになります。関数をexitするときに、変数の元の値がリストアされます。

See also: texi_macros_file, info_file, info_program, doc, help.

Built-in Function: val = texi_macros_file ()

Built-in Function: old_val = texi_macros_file (new_val)

Built-in Function: texi_macros_file (new_val, "local")

ドキュメント文字列がmakeinfoに渡される前に、文字列の前に追加されるTexinfoマクロを含むファイルの名前を指定する内部変数にたいして、問い合わせまたはセットを行います。デフォルト値は‘octave-home/share/octave/version/etc/macros.texi’です。ここで、octave-homeはOctaveをインストールしたルートディレクトリー、versionはOctaveのバージョンナンバーです。デフォルト値は、環境変数OCTAVE_TEXI_MACROS_FILE、またはコマンドライン引数‘--texi-macros-file FNAME’により、オーバーライドされるかもしれません。

関数の中から"local"オプションと共に呼び出された場合、変数への変更は、その関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、変数の元の値がリストアされます。

See also: makeinfo_program.

Built-in Function: val = doc_cache_file ()

Built-in Function: old_val = doc_cache_file (new_val)

Built-in Function: doc_cache_file (new_val, "local")

Octaveのドキュメントキャッシュファイルの名前を指定する内部変数にたいして、問い合わせ、またはセットを行います。キャッシュファイルは、lookforコマンドはパフォーマンスを大幅に改善します。デフォルト値は‘octave-home/share/octave/version/etc/doc-cache’です。ここで、octave-homeはOctaveをインストールしたルートディレクトリー、versionはOctaveのバージョンナンバーです。デフォルト値は、環境変数OCTAVE_DOC_CACHE_FILE、またはコマンドライン引数‘--doc-cache-file FNAME’によりオーバーライドされるかもしれません。

関数の中から"local"オプションと共に呼び出された場合、変数への変更は、その関数または関数のサブルーチンにたいしてローカルになります。関数をexitするとき、変数の元の値がリストアされます。

See also: doc_cache_create, lookfor, info_program, doc, help, makeinfo_program.

Built-in Function: val = built_in_docstrings_file ()

Built-in Function: old_val = built_in_docstrings_file (new_val)

Built-in Function: built_in_docstrings_file (new_val, "local")

Octaveのビルトイン関数のdocstringを含むファイルの名前を指定する内部変数にたいして、問い合わせまたはセットを行います。デフォルト値は‘octave-home/share/octave/version/etc/built-in-docstrings’です。ここで、octave-homeはOctaveをインストールしたルートディレクトリー、versionはOctaveのバージョンナンバーです。デフォルト値は、環境変数OCTAVE_BUILT_IN_DOCSTRINGS_FILE、またはコマンドライン引数‘--built-in-docstrings-file FNAME’によりオーバーライドされるかもしれません。

注意: この変数はOctave自身の初期化時だけ使用されます。Octaveセッション実行中に変更しても、Octaveに影響しません。

Built-in Function: val = suppress_verbose_help_message ()

Built-in Function: old_val = suppress_verbose_help_message (new_val)

Built-in Function: suppress_verbose_help_message (new_val, "local")

helpコマンドの出力とビルトイン関数の使い方メッセージのの最後に、Octaveが付加的なヘルプ情報を追加するかどうかと、を制御する内部変数にたいして、問い合わせまたはセットを行います。

関数の中から"local"オプションと共に呼び出された場合、変数の変更は、その関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、元の変数の値がリストアされます。

以下の関数は、ドキュメントを生成するために、主にOctaveにより内部的に使用されます。これらの関数は、ユーザーにとって便利なときがあるかもしれないので、ここに完全なドキュメントを示します。

Function File: doc_cache_create (out_file, directory)

与えられたディレクトリー内のすべての関数にたいするドキュメントキャッシュを生成します。

directory内のすべての関数にたいするドキュメントキャッシュを生成します。生成されたキャッシュは、ファイルout_fileに保存されます。このキャッシュは、lookforのスピードアップのために使用されます。

ディレクトリーが与えられない(または空のマトリクスが与えられた)場合は、ビルトイン演算子などにたいするキャッシュが生成されます。

See also: doc_cache_file, lookfor, path.

Built-in Function: [text, format] = get_help_text (name)

関数nameのrawヘルプテキストをリターンします。

textにrawヘルプテキスト、formatのフォーマットがリターンされます。フォーマットは文字列で、"texinfo"、"html"、"plain text"のうちの1つです。

Built-in Function: [text, format] = get_help_text_from_file (fname)

ファイルfnameのrawヘルプテキストをリターンします。

textにrawヘルプテキスト、formatのフォーマットがリターンされます。フォーマットは文字列で、"texinfo"、"html"、"plain text"のうちの1つです。

Function File: [text, status] = get_first_help_sentence (name)

Function File: [text, status] = get_first_help_sentence (name, max_len)

関数のヘルプテキストの最初のセンテンスをリターンします。

最初のセンテンスとは、関数定義の後ろから、最初のピリオド(".")、または連続する改行("\n\n")までのテキストです。テキストは最大長max_len(デフォルトは80)に切り詰められます。

オプションの出力引数statusには、makeinfoかｒ報告されたステータスがリターンされます。要求される出力引数が1つで、statusが非0の場合は警告が表示されます。

例として、この関数のヘルプテキストの最初のセンテンスは、以下のようになります

get_first_help_sentence ("get_first_help_sentence") -| ans = Return the first sentence of a function's help text.

2.4 Command Line Editing

Octaveは、豊富なコマンドライン編集とヒストリー機能を提供するために、GNU Readlineライブラリーを使用しています。このマニュアルでは、もっとも一般的な機能についてだけ説明します。さらに、すべての編集コマンドは、ユーザーにより自由に別のキーストロークのバインドできます。このマニュアルでは、Emacsのデフォルトのキーバインディングを変更していない前提で説明します。Readlineのカスタマイズと、完全な機能については、GNU Readlineのマニュアルを参照してください。

印字可能文字(文字、数字、シンボルなど)の挿入は、単にその文字をタイプするだけです。Octaveはカーソル位置に文字を挿入して、カーソルを前方に進めます。

コマンドライン編集関数の操作の多くは、コントロール文字を使用します。たとえば文字Control-aは、カーソルをその行の先頭に移動します。C-aのタイプは、<CTRL>を押したまま、<a>を押します。以降のセクションでは、Control-aのようなコントロール文字は、C-aと表記します。

メタ文字を使用するコマンドライン編集関数もあります。M-uをタイプするには、<META>キーを押したまま、<u>を押します。キーボードによっては、<META>が<ALT>とラベルされていたり、<WINDOWS>とラベルされていることさえあります。端末に<META>がない場合でも、ESCで始まる2文字シーケンスを使ってメタ文字を入力できます。この場合M-uを入力するには、<ESC>の次に<u>をタイプします。実際のMetaキーがある端末でも、ESC文字シーケンスは利用できます。以降のセクションでは、Meta-uのようなメタ文字は、M-uのように表記します。

2.4.1 Cursor Motion

以下のコマンドで、カーソルを動かすことができます。

C-b

1文字後退します。

C-f

1文字前進します。

<BACKSPACE>

カーソルの左の文字を削除します。

<DEL>

カーソルの下の文字を削除します。

C-d

カーソルの下の文字を削除します。

M-f

1単語前方に移動します。

M-b

1単語後方に移動します。

C-a

行の先頭に移動します。

C-e

行の末尾に移動します。

C-l

スクリーンをクリアーして、カレント行をスクリーンのトップに再印字します。

C-_

C-/

最後の操作をアンドゥします。すべてをアンドゥして空の行まで戻ることができます。

M-r

その行へのすべての変更をアンドゥします。これは最初に戻るまで充分な回数だけ‘undo’コマンドをタイプするのと同様です。

上記のテーブルでは、入力行で編集を行うのに必要となる、もっとも基本的な利用できるキーストロークを説明しています。ほとんどの端末では、C-fやC-bで前方または後方へ移動するのに、左矢印キーと右矢印キーも利用できます。

C-fは1文字前方、M-fは1単語前方へ移動する点に注目してください。コントロールによるキーストロークは文字単位の処理、メタによるキーストロークは単語単位の処理という、緩い慣習があります。

関数clcにとり、実行中のOctaveプログラム内のスクリーンをクリアーできます。

Built-in Function: clc ()

Built-in Function: home ()

端末スクリーンをクリアーして、カーソルを左上隅に移動します。

2.4.2 Killing and Yanking

テキストをキルするとは、行からテキストを削除しますが、後でそれを使用する(通常はヤンクにより行に戻す)ために、それを保存するという意味です。コマンドの説明で、そのコマンドがテキストを‘キル’する、と記述されているときは、後から違う(または同じ)場所に戻せることが保証されます。

以下はテキストをキルするコマンドのリストです。

C-k

現在のカーソル位置から行末までのテキストをキルします。

M-d

カーソルから現在の単語の末尾まで、カーソルが単語と単語の間にある場合は次の単語の末尾までをキルします。

M-<DEL>

カーソルから現在の単語の先頭まで、カーソルが単語と単語の間にある場合は前の単語の先頭までをキルします。

C-w

カーソルから前の空白までをキルします。単語境界が違うので、M-<DEL>とは異なります。

以下は、その行にテキストをyankで戻す方法です。ヤンクとは、kキルバッファーからもっとも最近キルされたテキストをコピーするという意味です。

C-y

そのバッファーのカーソル位置に、もっとも最近キルされたテキストをヤンクして戻します。

M-y

キルリンクをローテートして、新たなトップをヤンクします。直前のコマンドがC-yまたはM-yのときだけ、これを行なうことができます。

キルコマンドを使うと、そのテキストはキルリング(kill-ring)に保存されます。任意の回数の連続したキルコマンドは、キルされたすべてのテキストを1つにまとめるので、それをヤンクで戻すときは、一度にまとめてヤンクできます。キルリングは特定の行に限定されたものではありません。以前にタイプしたラインでキルしたテキストは、後で他の行をタイプしているときに、ヤンクで戻すことができます。

2.4.3 Commands For Changing Text

以降のコマンドは、他の場合では特別な意味をもつ文字(例: <TAB>、C-qなど)を入力したり、タイプミスをすばやく訂正するために使用できます。

C-q

C-v

次にタイプする文字そのものを、行に追加します。これは、C-qのような文字を挿入する方法の一例です。

M-<TAB>

Insert a tab character.

C-t

カーソルのある文字の前方にカーソルの前の文字をドラッグするとともに、カーソルを進めます。カーソルが行の末尾にある場合は、カーソルの前の2文字を入れ換えます。

M-t

同様に、カーソルの前方の単語をカーソルの後方へドラッグして、カーソルの後方にあった単語の前方にカーソルを移動します。

M-u

現在の単語(または次の単語からの)の末尾までを大文字にして、その単語の末尾にカーソルを移動します。

M-l

現在の単語(または次の単語からの)の末尾までを小文字にして、その単語の末尾にカーソルを移動します。

M-c

カーソルの前方(カーソルが単語と単語の間にある場合は次の単語の先頭)を大文字にして、その単語の末尾にカーソルを移動します。

2.4.4 Letting Readline Type For You

以降のコマンドにより、コマンドや変数の名前をOctaveに補完させることができます。

<TAB>

カーソルの前のテキストにたいして補完を試みます。Octaveはコマンドと変数の名前を補完することができます。

M-?

カーソルの前のテキストにたいして、可能な補完をリストします。

Built-in Function: val = completion_append_char ()

Built-in Function: old_val = completion_append_char (new_val)

Built-in Function: completion_append_char (new_val, "local")

コマンドラインの成功した補完に追加する文字のための内部変数にたいして、問い合わせまたはセットを行います。デフォルト値は" "(スペース1つ)です。

関数の中から"local"オプションと共に呼び出された場合、変数の変更は、その関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、元の変数の値がリストアされます。

Built-in Function: completion_matches (hint)

与えられたhintにたいして、可能な補完を生成します。

この関数は、Octaveを制御したりユーザー入力を処理するEmacsのようなプログラムのために提供されています。この関数が呼び出されても、カレントコマンドナンバーはインクリメントされません。これはバグではなく仕様です。

2.4.5 Commands For Manipulating The History

Octaveは通常、以前にタイプされたコマンドうぃ編集や再実行できるように、タイプしたコマンドを記録しています。Octaveをexitするとき、もっとも最近タイプされたコマンドから、変数history_sizeで指定された個数までのコマンドがファイルに保存されます。Octaveが開始されるとき、変数history_fileの名前のファイルから、コマンドの初期リストがロードされます。

以下は、ヒストリーリストを簡単に閲覧したり、検索するためのコマンドです。

<LFD>

<RET>

カーソルの位置に関わらず、カレント行を受け入れます。その行が空でない場合は、その行をヒストリーに加えます。その行がヒストリー行だった場合は、ヒストリー行を元の状態にリストアします。

C-p

ヒストリーリストを‘上’に移動します。

C-n

ヒストリーリストを‘下’に移動します。

M-<

ヒストリーリストの最初の行に移動します。

M->

入力ヒストリーの最後の行(あなたが入力している行です!)に移動します。

C-r

カレント行から後方検索を開始して、必要ならヒストリーを‘上’に移動します。これはインクリメンタル検索です。

C-s

カレント行から前方検索を開始して、必要ならヒストリーを‘下’に移動します。

多くの端末では、ヒストリーリストを移動するのに、C-pやC-nのかわりに上矢印キーと下矢印キーを使用できます。

ヒストリーリストを移動するコマンドに加えて、Octaveはヒストリーリストからコマンド群を閲覧、編集、再実行するために3つの関数を提供します。

Command: history

Command: history opt1 …

Built-in Function: h = history ()

Built-in Function: h = history (opt1, …)

引数を指定せずに呼び出すと、historyは実行されたコマンドのリストを表示します。有効なオプションは:

n

-n

ヒストリーリストのもっとも最近のn行だけを表示します。

-c

ヒストリーリストをクリアーします。

-q

表示されるヒストリーリストの番号を表示しません。これは、X Window Systemを使用してカットアンドペーストを行なうときに便利です。

-r file

ファイルfileを読み込んで、その内容をカレントヒストリーリストに追加します。名前が省略された場合はデフォルトのヒストリーファイル(通常は‘~/.octave_hist’)を使用します。

-w file

カレントヒストリーを、ファイルfileに書き込みます。名前が省略された場合はデフォルトのヒストリーファイル(通常は‘~/.octave_hist’)を使用します。

たとえば、もっとも最近タイプされたコマンド5つを、行番号なしで表示するには、コマンドhistory -q 5を使用します。

出力引数が1つで呼び出された場合、ヒストリーはその引数のセル文字列として保存され、スクリーンに表示されません。

Command: edit_history

Command: edit_history cmd_number

Command: edit_history first last

変数EDITORで指定された名前のエディターを使って、ヒストリーリストを編集します。

編集されるコマンドは、最初にテンポラリーファイルにコピーされます。エディターをexitするとき、Octaveはそのファイル内に残ったコマンドを実行します。関数を定義するとき、それを直接コマンドラインに入力するのではなく、edit_historyを使うほうが便利なときがあります。そのコマンドブロックは、エディターをexitするとすぐに実行されます。コマンドを実行したくないときは、エディターを抜けるときに、単にそのバッファーのすべての行を削除してください。

引数なしで呼び出された場合は、以前に実行されたコマンドを編集します。引数が1つの場合は、指定されたコマンドcmd_numberを編集します。引数が2つの場合は、firstとlastの間のコマンドを編集します。コマンド番号には、負の数も指定できます。この場合、-1はもっとも最近実行されたコマンドを参照します。以下のコマンドは等価で、どちらももっとも最近実行されたコマンドを編集します。

edit_history edit_history -1

範囲を使用する場合、最初のコマンドに最後のコマンドより大きい番号を指定すると、編集されるバッファーに配置される前に、コマンドリストを逆転します。

See also: run_history.

Command: run_history

Command: run_history cmd_number

Command: run_history first last

ヒストリーリストからコマンドを実行します。

引数なしで呼び出された場合は、以前に実行されたコマンドを実行します。引数が1つの場合は、指定されたコマンドcmd_numberを実行します。引数が2つの場合は、firstとlastの間のコマンドを実行します。コマンド番号には、負の数も指定できます。この場合、-1はもっとも最近実行されたコマンドを参照します。以下のコマンドは等価で、どちらももっとも最近実行されたコマンドを編集します。たとえば以下のコマンド

run_history OR run_history -1

はもっとも最近のコマンドを再実行します。また、

run_history 13 169

は13から169のコマンドを実行します。

最初のコマンドに最後のコマンドより大きい番号を指定すると、編集されるバッファーに配置される前に、コマンドリストを逆転します。たとえば:

disp (1) disp (2) run_history -1 -2 ⇒ 2 1

See also: edit_history.

Octaveでは、ヒストリーがいつ、どこで、どのように保存されたかの詳細もカスタマイズできます。

Built-in Function: val = history_save ()

Built-in Function: old_val = history_save (new_val)

Built-in Function: history_save (new_val, "local")

ヒストリーファイルに、コマンドがコマンドラインから入力されたかどうかを保存するか制御する内部変数にたいして、問い合わせまたはセットを行います。

関数内から"local"オプションと共に呼び出された場合、変数の変更はその関数および関数のサブルーチンにたいしてローカルになります。その関数をexitするとき、変数の元の値がリストアされます。

See also: history_control, history_file, history_size, history_timestamp_format_string.

Built-in Function: val = history_control ()

Built-in Function: old_val = history_control (new_val)

コマンドがヒストリーリストに保存される方法を指定する内部変数にたいして、問い合わせまたはセットを行います。デフォルト値は空文字列ですが、環境変数OCTAVE_HISTCONTROLによりオーバーライドされるかもしれません。

history_controlの値は、コマンドをヒストリーリストに保存する方法を制御する、コロンで区切られた値です。値リストがignorespaceを含む場合、スペース文字で始まる行は、ヒストリーリストに保存されません。ignoredupsでは、以前のヒストリーにマッチする行はヒストリーに保存されません。値ignorebothは、ignorespaceとignoredupsの省略指定です。値erasedupsは、カレント行がヒストリーリストに保存される前に、ヒストリーリストからマッチするすべての行を削除します。上記のリスト以外の値はすべて無視されます。history_controlが空文字列の場合、すべてのコマンドはhistory_saveの値として、すべてヒストリーリストに保存されます。

See also: history_file, history_size, history_timestamp_format_string, history_save.

Built-in Function: val = history_file ()

Built-in Function: old_val = history_file (new_val)

コマンドヒストリーを保存するのに使用するファイルの名前を指定する内部変数にたいして、問い合わせまたはセットを行います。デフォルト値は‘~/.octave_hist’ですが、環境変数OCTAVE_HISTFILEによりオーバーライドされるかもしれません。

See also: history_size, history_save, history_timestamp_format_string.

Built-in Function: val = history_size ()

Built-in Function: old_val = history_size (new_val)

ヒストリーファイルに保存するエントリー数を指定する内部変数にたいして、問い合わせまたはセットを行います。デフォルト値は1000ですが、環境変数OCTAVE_HISTSIZEによりオーバーライドされるかもしれません。

See also: history_file, history_timestamp_format_string, history_save.

Built-in Function: val = history_timestamp_format_string ()

Built-in Function: old_val = history_timestamp_format_string (new_val)

Built-in Function: history_timestamp_format_string (new_val, "local")

Octaveをexitするときにヒストリーファイルに書き込まれるコマンドラインにたいするフォーマット文字列を指定する内部変数にたいして、問い合わせまたはセットを行います。このフォーマット文字列はstrftimeに渡されます。デフォルト値は

"# Octave VERSION, %a %b %d %H:%M:%S %Y %Z <USER@HOST>"

関数内から"local"オプションと共に呼び出された場合、変数の変更はその関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、変数の元の値がリストアされます。

See also: strftime, history_file, history_size, history_save.

Built-in Function: val = EDITOR ()

Built-in Function: old_val = EDITOR (new_val)

Built-in Function: EDITOR (new_val, "local")

デフォルトのテキストエディターを指定する内部変数にたいして、問い合わせまたはセットを行います。

デフォルト値はOctave開始時に環境変数EDITORから取得されます。環境変数が初期化されない場合、EDITORは"emacs"にセットされます。

関数の中から"local"オプションと共に呼び出された場合、変数の変更は、その関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、元の変数の値がリストアされます。

See also: edit, edit_history.

2.4.6 Customizing readline

Octaveはコマンドライン変数およびヒストリー機能のために、GNU Readlineライブラリーを使用しています。Readlineはとてもフレキシブルで、コマンドの設定ファイルを通じてカスタマイズできます(正確なコマンド構文についてはGNU Readlineライブラリーを参照してください)。デフォルトの設定ファイルは通常、‘~/.inputrc’です。

OctaveはReadlineを初期化するためのコマンドを提供しており、それによりコマンドラインの挙動を変更できます。

Built-in Function: readline_read_init_file (file)

readline初期化ファイルfileを読み込みます。fileが省略された場合には、デフォルトの初期化ファイル(通常は‘~/.inputrc’)を読み込みます。

詳細は(readline)Readline Init File section ‘Readline Init File’ in GNU Readline Libraryを参照してください。

See also: readline_re_read_init_file.

Built-in Function: readline_re_read_init_file ()

最後に読み込んだreadline初期化ファイルを再読込します。詳細は (readline)Readline Init File section ‘Readline Init File’ in GNU Readline Libraryを参照してください。

See also: readline_read_init_file.

2.4.7 Customizing the Prompt

以降の変数による、コマンドラインプロンプトの外観をカスタマイズできます。Octaveでは、バックスラッシュでエスケープされたいくつかの特別な文字を挿入することにより、プロンプトをカスタマイズできます。それらの文字は以下のようにデコードされます:

‘\t’

時刻。

‘\d’

日付。

‘\n’

改行と復帰と等価なものをプリントすることにより、新たな行を開始します。

‘\s’

プログラムの名前(通常は単に‘octave’)です。

‘\w’

カレントワーキングディレクトリー。

‘\W’

カレントワーキングディレクトリーのbasename。

‘\u’

カレントユーザーのユーザー名。

‘\h’

最初の‘.’までのhostname。

‘\H’

hostname。

‘\#’

Octave起動後からカウントした、そのコマンドのコマンド番号。

‘\!’

そのコマンドのヒストリー番号。これはOctave開始時からのヒストリーリスト内のコマンド数なので、‘\#’とは異なります。

‘\$’

実行UIDが0のときは‘#’、それ以外は‘$’。

‘\nnn’

文字コードが8進nnnの文字。

‘\\’

バックスラッシュ。

Built-in Function: val = PS1 ()

Built-in Function: old_val = PS1 (new_val)

Built-in Function: PS1 (new_val, "local")

一次プロンプト(primary prompt)文字列にたいして、問い合わせまたはセットを行います。インタラクティブに実行された場合は、コマンドを読み取る準備ができたときに、Octaveは一次プロンプトを表示します。

一次プロンプト文字列のデフォルト値は"octave:#> "です。これを変更するには、以下のようなコマンドを使用します。

PS1 ("\\u@\\H> ")

これは、ホスト‘kremvax.kgb.su’にログインしているユーザー‘boris’のプロンプトを、‘boris@kremvax> ’にします。ダブルクォートされた文字列内にバックスラッシュを入力するには、バックスラッシュが2つ必要なことに注意してください。Stringsを参照してください。

端末がサポートしていれば、ANSIエスケープシーケンスも使用できます。これはプロンプトにカラーを使いたいとき便利かもしれません。たとえば、

PS1 ("\\[\\033[01;31m\\]\\s:\\#> \\[\\033[0m\\]")

これはデフォルトのOctaveプロンプトのカラーを赤にします。

関数の中から"local"オプションと共に呼び出された場合、変数の変更はその関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、変数の元の値がリストアされます。

See also: PS2, PS4.

Built-in Function: val = PS2 ()

Built-in Function: old_val = PS2 (new_val)

Built-in Function: PS2 (new_val, "local")

二次プロンプト文字列にたいして、問い合わせまたはセットを行います。二次プロンプトは、Octaveがコマンドを完成させるために、追加入力を待っているときにプリントされます。たとえば、複数行に分かれたforループをタイプしているとき、Octaveは最初の行以降の各行の先頭に二次プロンプトをプリントするでしょう。二次プロンプト文字列のデフォルト値は、"> "です。

関数の中から"local"オプションと共に呼び出された場合、変数の変更はその関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、元の変数の値がリストアされます。

See also: PS1, PS4.

Built-in Function: val = PS4 ()

Built-in Function: old_val = PS4 (new_val)

Built-in Function: PS4 (new_val, "local")

コマンドのエコーが有効なときに、生成された出力のプレフィクスに使用する文字列の、問い合わせまたはセットを行います。デフォルト値は"+ "です。コマンドのエコーについての説明は、Diary and Echo Commandsを参照してください。

関数の中から"local"オプションと共に呼び出された場合、変数の変更はその関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、変数の元の値がリストアされます。

See also: echo, echo_executing_commands, PS1, PS2.

2.4.8 Diary and Echo Commands

Octaveのダイアリー機能により、インタラクティブなセッションのすべて、または一部のログを維持できます。これは、タイプされた入力と、Octaveが生成した出力を、別のファイルに記録することにより行なわれます。

Command: diary

Command: diary on

Command: diary off

Command: diary filename

すべてのコマンドのリストおよびそれらが生成した出力を、まさに端末に表示されたよｙに混在して記録します。

有効なオプションは:

on

カレントワーキングディレクトリーの‘diary’と呼ばれるファイルへ、セッションの記録を開始します。

off

ダイアリーファイルへのセッションの記録を停止します。

filename

filenameという名前のファイルに、セッションを記録します。

引数を指定しない場合、カレントダイアリーの状態うぃ切り替えます。

See also: history.

関数やスクリプトが評価されるときに、それらの中のコマンドを確認できると便利な場合があります。これは、ある種の問題をデバッグするとき、特に助けになるでしょう。

Command: echo options

コマンドが評価されるときに、それらのコマンドを表示するかどうかを制御します。有効なオプションは:

on

スクリプトファイル内でコマンドが実行されるとき、エコーを有効にします。

off

スクリプトファイル内でコマンドが実行されるとき、エコーを無効にします。

on all

スクリプトファイルおよび関数内でコマンドが実行されるとき、エコーを有効にします。

off all

スクリプトファイルおよび関数内でコマンドが実行されるとき、エコーを無効にします。

引数を指定しない場合、echoはエコー状態を切り替えます。

Built-in Function: val = echo_executing_commands ()

Built-in Function: old_val = echo_executing_commands (new_val)

Built-in Function: echo_executing_commands (new_val, "local")

エコー状態を制御する内部変数にたいして、問い合わせまたはセットを行います。値は以下の値の和になるでしょう:

1

スクリプトファイルから読み込んだコマンドをエコーします。

2

関数のコマンドをエコーします。

4

コマンドラインから読み込んだコマンドをエコーします。

一度に2つ以上の状態がアクティブになり得ます。たとえば、値3は、コマンドecho on allと等価です。

echo_executing_commandsの値は、echoコマンドまたはコマンドラインオプション‘--echo-commands’によりセットされるかもしれません。

関数の中から"local"オプションと共に呼び出された場合、変数の変更は、その関数または関数のサブルーチンにたいしてローカルになります。関数をexitするときに、元の変数の値がリストアされます。

2.5 How Octave Reports Errors

Octaveは無効なプログラムにたいして、2つの種類のエラーをリポートします。

パースエラーは、Octaveがタイプされたものを理解できなかった場合に発生します。たとえば、キーワードのスペルミスをした場合、

octave:13> function y = f (x) y = x***2; endfunction

Octaveは即座に次のようなメッセージを返すでしょう:

parse error:

  syntax error

>>> function y = f (x) y = x***2; endfunction
                              ^

多くのパースエラーにたいして、Octaveは入力行で理解できなかった箇所をマークするのに、キャレット(‘^’)を使用します。上記のケースでは、べき乗(**)にたいするキーワードにスペルミスがあるので、Octaveはエラーメッセージを生成しました。キャレットは3つ目の‘*’にエラーをマークしました。なぜなら、その箇所まではコードは正しく読み取れていたけれど、最後の‘*’が理解できなかったからです。

他のクラスのエラーメッセージは、評価時に発生します。これらのエラーは、ランタイムエラーまたは, 評価エラーと呼ばれることもあります。これは、それらのエラーが、プログラムが実行(run)あるいは評価(evaluate)されるときに発生するからです。たとえば、前の関数定義のミスを訂正したあとで、以下をタイプしたとします

octave:13> f ()

Octaveは以下のように応答するでしょう

error: `x' undefined near line 1 column 24
error: called from:
error:   f at line 1, column 22

このエラーメッセージにはいくつかのパートがあります。そして、それらはエラーのあるソースを見つける助けとなる情報を多く含んでいます。このメッセージは、最内のエラー箇所から生成され、それを囲む式と関数呼び出しのバックトレースを提供します。

上記の例の最初の行は、何らかの関数または式の、行1、列24の近くで、名前‘x’の未定義な変数が見つかったことを示しています。関数内で発生したエラーにたいしては、行はその関数定義を含むファイルの先頭から数えた行のことです。関数の外側で発生したエラーにたいしては、行番号は入力行番号であり、これは通常一次プロンプト文字列に表示されています。

エラーメッセージの2行目と3行目は、このエラーが関数fの中で発生したことを示しています。もし関数fがさらに他の関数、たとえばgから呼び出されていた場合には、エラーリストにはさらに以下のような1行が加わるでしょう:

error:   g at line 1, column 17

これらの関数呼び出しのリストは、エラーが発生するまでにそのプログラムがとったパスのトレースと、プログラムを再試行する前にエラーを訂正するのを、とても簡単にします。

2.6 Executable Octave Programs

一度Octaveを習得したら、‘#!’スクリプトメカニズムを使ってOctaveによる自己完結型スクリプトを記述したいと思うかもしれません。これはGNUシステム、および多くのUnixシステム(1)で行なうことができます。

Octave自己完結型スクリプトは、Octave言語で記述されたプログラムに関する知識を要さずに、ユーザーが呼び出せるプログラムを記述したいときに便利です。Octaveスクリプトは、データファイルのバッチプロセッシングにも使用されます。一度アルゴリズムが開発され、Octaveのインタラクティブ環境でテストされれば、それを実行可能スクリプトにコミットして、データファイルに何度も使用できます。

実行可能Octaveスクリプトの些細な例として、あなたは以下の行を含む‘hello’という例の名前のファイルを作るかもしれません:

#! octave-interpreter-name -qf
# a sample Octave program
printf ("Hello, world!\n");

(octave-interpreter-nameはOctaveバイナリーのフルパスで置き換えてください)。スクリプトはファイルの先頭に‘#!’があるときだけ機能することに注意してください。(Unixシステムではchmodで)ファイルを実行可能にした後は、以下のようにシェル上で単にタイプできます:

hello

システムはあなたがタイプしたものを以下のようにアレンジして、Octaveを実行します:

octave hello

‘#!’で始まる行は、実行されるインタープリターのファイル名へのフルパスと、そのインタープリターに渡す初期化のためのオプションのコマンドライン引数です。するとオペレーティングシステムは与えられた引数と、実行されるプログラムの完全な引数リストにより、インタープリターを実行します。リストの最初の引数は、実行可能なOctaveのフルパスファイル名です。引数リストの残りはOctaveへのオプション、データファイル、またはその両方です。‘-qf’オプションは通常、スタンドアローンなOctaveプログラム内での、通常のスタートアップメッセージのプリントを抑止して、特定のユーザーの‘~/.octaverc’の内容に依存した異なる挙動から守ります。Invoking Octave from the Command Lineを参照してください。

‘#!’の後ろの文字数に制限のあるオペレーティングシステムがいくつかあることに注意してください。また、‘#!’の行内の引数のパースは、さまざまなシェルやシステムにより異なります。これらの多くは、すべての引数を1つの文字列にまとめて、インタープリターに1つの引数として渡します。この場合、以下のスクリプト:

#! octave-interpreter-name -q -f # comment

は、コマンドラインで以下のようにタイプするのと等価です:

octave "-q -f # comment"

そして、これはエラーになるでしょう。残念ながら、コマンドラインから呼び出されたのか、それとも‘#!’スクリプトから呼び出されたかを、Octaveが判断するのは不可能です。したがって、‘#!’メカニズムを使用するときは、いくつかの配慮が必要です。

Octaveが実行可能スクリプトから起動された場合、ビルトイン関数argvはスクリプトの‘#!’行でOctaveインタープリターに渡された引数ではなく、実行可能Octaveスクリプトに渡されたコマンドライン引数を含むセル配列をリターンします。たとえば、以下のプログラムは‘-qf’ではなく、スクリプトを実行するために使用されたコマンドライン引数を再現します。

#! /bin/octave -qf
printf ("%s", program_name ());
arg_list = argv ();
for i = 1:nargin
  printf (" %s", arg_list{i});
endfor
printf ("\n");

2.7 Comments in Octave Programs

コメントとは、人間の読み手のためにプログラム中に含まれるテキストのことで、このテキストはプログラムの実行パートではありません。コメントにより、そのプログラムが何を行なうか、どのように機能するか説明することができます。ほとんどすべてのプログラミング言語にはコメントにたいする規約があります。なぜならプログラムは通常、コメントがなければ理解するのが困難だからです。

2.7.1 Single Line Comments

Octave言語では、コメントはシャープ記号‘#’、あるいはパーセント記号‘%’のどちらかで始まり、その行の末尾までがコメントになります。シャープ記号またはパーセント記号に続く任意のテキストは、Octaveインタープリターには無視され、実行されません。以下の例では、行全体のコメントと、行の一部を使用したコメントが使用されています。

function countdown
  # Count down for main rocket engines 
  disp (3);
  disp (2);
  disp (1);
  disp ("Blast Off!");  # Rocket leaves pad
endfunction

2.7.2 Block Comments

マッチする‘#{’と‘#}’、または‘%{’と‘%}’で囲むことにより、コードブロック全体をコメント化することができます。たとえば、

function quick_countdown
  # Count down for main rocket engines 
  disp (3);
 #{
  disp (2);
  disp (1);
 #}
  disp ("Blast Off!");  # Rocket leaves pad
endfunction

これは、"disp (2);"と"disp (1);"を実行しないことにより、'3'から"Blast Off"へのとても素早いカウントダウンを生成します。

ブロックコメントマーカーは、正しくパースされるために、その行で(空白文字以外の)単独の文字として記述しなければなりません。

2.7.3 Comments and the Help System

helpコマンド(Commands for Getting Help参照)は、関数の最初のコメントブロックを見つけて、それらをドキュメント文字列としてリターンします。これはヘルプを取得するために使用する同じコマンドが、ユーザー定義関数を正しくフォーマットできることを意味します。たとえば、以下の関数fを定義してみます

function xdot = f (x, t)

# usage: f (x, t)
#
# This function defines the right-hand
# side functions for a set of nonlinear
# differential equations.

  r = 0.25;
  …
endfunction

すると、コマンドhelp fは以下の出力を生成します

 usage: f (x, t)

 This function defines the right-hand
 side functions for a set of nonlinear
 differential equations.

キーボード入力して使い捨てするプログラムにコメント行を挿入することはできますが、これは通常とても有用とは言えません。なぜならコメントの目的は、後で他の人がプログラムを理解する助けとなることだからです。

helpパーサーは、初期ヘルプテキストとして、1行コメント(Single Line Comments参照)だけを正しく認識します。

3. Data Types

Octaveのすべてのバージョンにはいくつかのビルトインデータ型が含まれます。それらには、real(実数)およびcomplex(複素数)にたいするスカラー(scalar)とマトリクス(matrix)、文字列(character string)、データ構造型(data structure type)、そしてすべてのデータ型を含むことができる配列(array)が含まれます。

少しC++コードを記述すれば、新しく特別なデータ型を定義することもできます。Octave実行中に新しいデータ型をダイナミック(動的)にロードできるシステムもいくつかあり、その場合はOctaveすべてをリコンパイルせずに、新しいデータ型を単に追加できます。Octaveのダイナミックリンク能力についての情報は、External Code Interfaceを参照してください。User-defined Data Typesでは、Octaveに新しいデータ型を定義するために、何を行わなければならないか説明しています。

Built-in Function: typeinfo ()

Built-in Function: typeinfo (expr)

式exprの型を、文字列でリターンします。exprが省略された場合は、現在インストールされているデータ型すべてを含む文字列のセル配列をリターンします。

See also: class, isa.

3.1 Built-in Data Types

標準のビルトインデータ型は、real(実数)およびcomplex(複素数)のスカラー(scalar)およびマトリクス(matrix)、range(レンジ、範囲)、文字列(character string)、データ構造型(data structure type)、セル配列(cell array)です。将来のバージョンで、さらにビルトインデータ型が追加されるかもしれません。現在ビルトイン型として提供されていない、特別なデータ型が必要な場合は、あなたが独自にユーザー定義データ型を記述して、それをOctaveの将来リリースのディストリビューションのために寄贈されることをお勧めします。

以下の関数を使用して、変数のデータ型の判定と変更ができます。

Function File: classname = class (obj)

Function File: class (s, id)

Function File: class (s, id, p, …)

オブジェクトobjのクラスをリターン、または構造sのフィールド、およびnameフィールド(文字列)がidのクラスを作成します。追加の引数は、新しいクラスがどのクラスから継承されたかを示す親クラスの名前のリストです。

See also: typeinfo, isa.

Function File: isa (obj, classname)

objがクラスclassnameならばtrueをリターンします。

classnameは、以下のクラスカテゴリーの1つかもしれません:

"float"

float(浮動小数点)の値は、クラス"double"および"single"を包括します。

"integer"

integer(整数)の値は、クラス(u)int8、(u)int16、(u)int32、(u)int64を包括します。

"numeric"

numericの値は、浮動小数点値と整数値を包括します。

See also: class, typeinfo.

Function File: cast (val, type)

valをデータ型typeに変換します。

See also: int8, uint8, int16, uint16, int32, uint32, int64, uint64, double.

Built-in Function: typecast (x, class)

メモリー内でxのデータをnumericクラスclassのデータとして解釈し、結果を新たな配列yでリターンします。xとclassはどちらも、ビルトインnumericクラスの1つでなければなりません。

"logical" "char" "int8" "int16" "int32" "int64" "uint8" "uint16" "uint32" "uint64" "double" "single" "double complex" "single complex"

最後の2つは、classのために予約されています。これらは、complex値の結果が要求されていることを示します。complex配列は、連続するreal値として、メモリー内に格納されます。integer型のサイズは、それらのビット数で与えられます。logicalとcharはどちらも1バイト幅です。しかしこれはC++により保証されていません。システムがIEEE準拠の場合、singleとdoubleは、4バイトおよび8バイト幅です。"logical"は、classに指定できません。入力が行ベクターならリターン値は行ベクターで、それ以外は列ベクターです。xのビット長がclassのビット長の倍数でない場合は、エラーが発生します。

リトルエンディアン機でtypecastを使用する例は

x = uint16 ([1, 65535]); typecast (x, "uint8") ⇒ [ 1, 0, 255, 255]

See also: cast, bitunpack, bitpack, swapbytes.

Function File: swapbytes (x)

値のバイト順を入れ替えて、リトルエンディアンからビッグエンディアン、またはその逆の変換をします。

swapbytes (uint16 (1:4)) ⇒ [ 256 512 768 1024]

See also: typecast, cast.

Built-in Function: y = bitpack (x, class)

配列xをnumericクラスclassのrawビット配列として解釈した結果を、新たな配列yでリターンします。classはビルトインnumericクラスのうちの1つでなければなりません。

"char" "int8" "int16" "int32" "int64" "uint8" "uint16" "uint32" "uint64" "double" "single"

xの要素の個数は、classのビット長の倍数である必要があります。もしそうでない場合には、余分なビットは無視されます。ビット順は、x(1)がビット0、x(2)がビット1、のように、昇順になっています。結果は、xが行ベクターなら行ベクター、それ以外は列ベクターになります。

See also: bitunpack, typecast.

Built-in Function: y = bitunpack (x)

xのrawビットパターンに対応する配列yをリターンします。xはビルトインnumericクラスの1つに属していなければなりません:

"char" "int8" "int16" "int32" "int64" "uint8" "uint16" "uint32" "uint64" "double" "single"

結果はxが行ベクターなら行ベクター、それ以外は列ベクターです。

See also: bitpack, typecast.

3.1.1 Numeric Objects

Octaveのビルトインnumericオブジェクトには、real、complex、integerのスカラーとマトリクスが含まれます。すべてのビルトイン浮動小数点numericデータは、現在のところ倍精度浮動小数点数として格納されます。IEEE浮動小数点フォーマットを使用するシステムでは、およそ 2.2251e-308から1.7977e+308 までの範囲の値が格納でき、相対精度はおよそ 2.2204e-16です。 正確な値はそれぞれ、変数realmin、realmax、epsで得ることができます。

マトリクスオブジェクトは任意のサイズをとることができ、動的に変形やサイズ変更ができます。種々の強力なインデクス機能を使用して、特定の行や列、サブマトリクスが簡単に抽出できます。Index Expressionsを参照してください。

詳細は、Numeric Data Typesを参照してください。

3.1.2 Missing Data

Octaveでは、NA(“Not Available”の略)を使用して、欠損データを明示的に表すことができます。欠損データが表されるのは、データが浮動小数点数として表されるときだけです。この場合、欠損データはNaNの特別なケースとして表されます。

Built-in Function: NA

Built-in Function: NA (n)

Built-in Function: NA (n, m)

Built-in Function: NA (n, m, k, …)

Built-in Function: NA (…, class)

すべての要素が、欠損値を示すために使用される特別な定数と等しいようなスカラー、マトリクス、N次元配列をリターンします。

NAとNAの比較は常にノットイコール(NA != NA)になることに注意してください。NA値を見つける場合には、isna関数を使用してください。

引数を指定しないで呼び出された場合は、値‘NA’のスカラーをリターンします。1つの引数で呼び出された場合は、指定された次元の正方マトリクスをリターンします。2つ以上のスカラー引数で呼び出された場合、最初の2つは行数と列数を指定し、残りは追加のマトリクス次元を指定します。オプション引数classは、リターン型を指定し、"double"か"single"です。

See also: isna.

Mapping Function: isna (x)

xの要素がNA値(欠損値)のところはtrue、異なるところはfalseであるようなlogical配列をリターンします。たとえば:

isna ([13, Inf, NA, NaN]) ⇒ [ 0, 0, 1, 0 ]

See also: isnan, isinf, isfinite.

3.1.3 String Objects

Octaveでの文字列は、ダブルクォーテーション、またはシングルクォーテーションで囲まれた文字シーケンスで構成されます。内部的には現在のところ、Octaveは文字列を文字のマトリクスとして格納します。マトリクスオブジェクトに機能するインデクス操作のすべては、文字列にたいしても機能します。

詳細は、Stringsを参照してください。

3.1.4 Data Structure Objects

Octaveにデータ構造型は、異なる型の関連するオブジェクトを組織化する助けになります。現在の実装では、インデクスが文字列に限定された連想配列を使用しますが、構文はCスタイルの構造体に類似しています。

詳細は、Structuresを参照してください。

3.1.5 Cell Array Objects

Octaveのセル配列(Cell Array)は、異なるデータ型を任意個もつことができる、汎用配列です。

詳細は、Cell Arraysを参照してください。

3.2 User-defined Data Types

わたしはいつかOctaveのユーザー定義データ型の管理にたいする管理メカニズムについての完全なドキュメントを含めることで、このセクションを拡張したいと思っています。ここにその機能がドキュメントされるまで、あなたがそれを行なうためには、Octaveの‘src’ディレクトリーにある‘ov.h’、‘ops.h’、および関連するファイルのコードを読む必要があるでしょう。

3.3 Object Sizes

以降の関数により、変数や式のサイズを判定できます。これらの関数は、すべてのオブジェクトにたいして定義されています。これらは操作に意味がない場合は、-1をリターンします。たとえば、Octaveのデータ構造型は行や列を持たないので、rowsやcolumnsの関数は、構造型の引数にたいしては、-1をリターンします。

Built-in Function: ndims (a)

aの次元数をリターンします。任意の配列にたいし、結果は2以上になります。後続のシングルトン次元(singleton dimension: 1と等しい次元)はカウントされません。

ndims (ones (4, 1, 2, 1)) ⇒ 3

See also: size.

Built-in Function: columns (a)

aの列数をリターンします。

See also: rows, size, length, numel, isscalar, isvector, ismatrix.

Built-in Function: rows (a)

aの行数をリターンします。

See also: columns, size, length, numel, isscalar, isvector, ismatrix.

Built-in Function: numel (a)

Built-in Function: numel (a, idx1, idx2, …)

オブジェクトa内の要素数をリターンします。オプションで、もしidx1、idx2、…が与えられた場合は、インデクス操作の結果

a(idx1, idx2, …)

の要素数をリターンします。インデクスは数値である必要はないことに注意してください。たとえば、

a = 1; b = ones (2, 3); numel (a, b)

こてはbでインデクスをつける方法で、6をリターンします。

この手法は、オブジェクトがcsリスト(カンマ区切りリスト)のインデクス操作のlvalue(左辺値)として現れたときにも使用されます(例: object{…}またはobject(…).field)。

See also: size.

Built-in Function: length (a)

オブジェクトaの長さをリターンします。

lengthは、空のオブジェクトにたいしては0、スカラーにたいしては1、ベクターにたいしては要素数です。マトリクスオブジェクトについては、行数または列数の大きい方がlengthになります(この奇妙な定義は、MATLABとの互換のために使用されます)。

See also: numel, size.

Built-in Function: size (a)

Built-in Function: size (a, dim)

aの行数と列数をリターンします。

入力引数が1つで、出力引数が1つの場合、結果は行ベクターでリターンされます。出力引数が複数の場合、行数が1つ目、列数が2つ目の出力引数、などとなります。たとえば:

size ([1, 2; 3, 4; 5, 6]) ⇒ [ 3, 2 ] [nr, nc] = size ([1, 2; 3, 4; 5, 6]) ⇒ nr = 3 ⇒ nc = 2

2つ目の引数が与えられた場合、sizeは対応する次元のサイズをリターンします。たとえば、

size ([1, 2; 3, 4; 5, 6], 2) ⇒ 2

これは与えられたマトリクスの列数をリターンします。

See also: numel, ndims, length, rows, columns.

Built-in Function: isempty (a)

aが空のマトリクス(マトリクスの次元のうち1つが0)の場合はtrue、それ以外はfalseをリターンします。

See also: isnull, isa.